WRR-387: Panels: Updated documentation for arranger
#1752
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enact-DCO-1.0-Signed-off-by: Jiye Kim (jiye.kim@lge.com)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1752 +/- ##
===========================================
+ Coverage 80.80% 81.77% +0.96%
===========================================
Files 148 148
Lines 6675 7022 +347
Branches 1985 2148 +163
===========================================
+ Hits 5394 5742 +348
- Misses 972 973 +1
+ Partials 309 307 -2 ☔ View full report in Codecov by Sentry. |
MikyungKim
changed the title
MikyungKim
changed the title
Panels: Updated documentation for arranger
MikyungKim
reviewed
Nov 22, 2024
internal/Panels/Arrangers.js
Outdated
| @@ -129,6 +129,9 @@ const deferArrange = (config, keyframes, options) => { | |||
| /** | |||
| * Arranger that slides panels in from the right and out to the left. | |||
| * | |||
| * This arranger is visually same as {@link ui/ViewManager.SlideLeftArranger} when transition but uses transform percentages instead of pixel values. | |||
There was a problem hiding this comment.
It looks like ui/ViewManager.SlideLeftArranger already use percentages. So I think this comment should be revised.
If the visual is the same, what makes difference between SlideLeftArranger and BasicArranger?
I see BasicArranger uses deferArrange and offset. Please find more details about this.
There was a problem hiding this comment.
offsetvalues here don't affect animation (https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)deferArrangewas defined in PLAT-112222: Change BasicArranger to defer animation until idle #577 and it prevents skipping transition animations under system load. I updated the comments.
Enact-DCO-1.0-Signed-off-by: Jiye Kim (jiye.kim@lge.com)
MikyungKim
reviewed
Dec 19, 2024
Enact-DCO-1.0-Signed-off-by: Jiye Kim (jiye.kim@lge.com)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Issue Resolved / Feature Added
Default value of
arrangerprop inSandstone/Panelsdoes not match the documentation.Documentation says the default is
ui/ViewManager.SlideLeftArranger, but actual value isBasicArrangerfrominternals/Panles/Arrangers.js.Resolution
Default value was changed in #315 from
SlideLeftArrangertoBasicArrangerandarrangeinBasicArrangerwas changed todeferArrangein #577But
BasicArrangeris for internal use.So instead of updating documentation of
arrangerinSandstone/Panels, I updated documentation ofBasicArrangerto explain what it is.Additional Considerations
Links
WRR-387
Comments
Enact-DCO-1.0-Signed-off-by: Jiye Kim (jiye.kim@lge.com)